gridpack::parallel::DistributedInterface Class Reference

Abstract class describing a parallel thing. More...

#include <distributed.hpp>

Inheritance diagram for gridpack::parallel::DistributedInterface:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DistributedInterface (void)
 Default constructor.
 DistributedInterface (const DistributedInterface &old)
 Copy constructor.
virtual ~DistributedInterface (void)
 Destructor.
virtual const Communicatorcommunicator (void) const =0
 Get the communicator.
int processor_rank (void) const
 Get this processor's rank.
int processor_size (void) const
 Get the size of the parallel environment.

Detailed Description

Abstract class describing a parallel thing.

A parallel thing either contains or has access to a Communicator. A parallel thing needs access to this communicator, especially to determine the number processors and the local processor rank.


Constructor & Destructor Documentation

gridpack::parallel::DistributedInterface::DistributedInterface ( void   ) 

Default constructor.

gridpack::parallel::DistributedInterface::DistributedInterface ( const DistributedInterface old  ) 

Copy constructor.

virtual gridpack::parallel::DistributedInterface::~DistributedInterface ( void   )  [virtual]

Destructor.


Member Function Documentation

virtual const Communicator& gridpack::parallel::DistributedInterface::communicator ( void   )  const [pure virtual]

Get the communicator.

Implemented in gridpack::parallel::Distributed, and gridpack::parallel::WrappedDistributed.

int gridpack::parallel::DistributedInterface::processor_rank ( void   )  const

Get this processor's rank.

References communicator(), and gridpack::parallel::Communicator::rank().

int gridpack::parallel::DistributedInterface::processor_size ( void   )  const

Get the size of the parallel environment.

References communicator(), and gridpack::parallel::Communicator::size().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 3 Feb 2020 for GridPACK by  doxygen 1.6.1